The Insert link by permission AS component

Inserts a link or a button in a document if the caller has a certain permission or a set of permissions on the document or a category.

When to use

This component is typically used when there is a need to insert a link to another document depending on whether or not the user has permission to that document.

Mandatory parameters

LinkText

Available in presentation templates only. The name of an EPT field that contains the text of the link element.

StaticLinkText

A static text of the link element.

LinkURL

For links and Advanced buttons only and available in presentation templates only. If this value is an ID the link or button will navigate to this Content Studio item. An EPT field name that contains the URL or DocumentID that the link should navigate to.

StaticLinkURL

A static document id or url that the link or advanced button should navigate to. Available in any document.

Rendering options

• Render a regular link
• Render a submit button (The generated object is an ordinary submit button.)
• Render a button element (The generated object is an BUTTON element.)

Render as disabled if no permission

For buttons only. The button will be disabled instead of hidden. Useful on browsers that supports the disabled attribute.

Image options

LinkImage

Optional, The name of an EPT field that contains the image of the link object. Available in presentation templates only.

StaticLinkImage

A static image to display in the link element.

ImageAlt

Optional, The name of an EPT field that contains an alternative text for the link image. Available in presentation templates only.

StaticImageAlt

A static alt text for the image. Available in any document.

Optional link / button options

Title

Available in presentation templates only. Optional name of an EPT field that contains the title that displays as a rollover...

StaticTitle

or static title

Target

Optional, the name of an EPT field that contains the target for link object. For links only and available in presentation templates only.

StaticTarget

A static target the target for link object. For links only but available i any type of document.

Class

Optional, the name of an EPT field that contains the class name of the link element. Available in presentation templates only. The class attribute is omitted if not specified.

StaticClass

A static CSS class to be used to format the link element. The class attribute is omitted if not specified.

ObjectAttributes

HTML code that will be inserted as attributes of the link element.

Access check options

Check for lack of permissions

The component will display the link object only if the caller lacks the permission i.e. the opposite behaviour.

Access check targets

• Check the current document. (Access check will be performed on the actual document - XML document if presentation template).
• Check the root document. (Access check will be performed on the parent document if the document is an include - XML document if presentation template).
• Check a category of choice. (Access check will be performed on a user defined category).

Category of choice

A category that permissions will be checked against. Used only if the "Check a category of choice" is selected.

Permission to check (at least one must be supplied)

Browse document on site

Check for permission to read on site. Useful on document level, on category level for inheritance only and is unpredictable.

Read / list

Check for the read/list permission. Useful on document level, on category level for inheritance only and is unpredictable.

Write document content

Check for the write/edit permission. Useful on document level, on category level for inheritance only and is unpredictable.

Create document

Check for create permission. Useful on category level only.

Delete document

Check for delete permission. Useful on document level, on category level for inheritance only and is unpredictable.

Approve document

Check for the approve permission. Useful on document level, on category level for inheritance only and is unpredictable.

Start workflow

Check for the start workflow permission. Useful on document level, on category level for inheritance only and is unpredictable.

Reject a workflow item

Check for the reject document on workflow permission. Useful on document level, on category level for inheritance only and is unpredictable.

Terminate workflow

Check for the terminate workflow permission. Useful on document level, on category level for inheritance only and is unpredictable.

Administrative privileges and change permissions

Check for the permission to change permissions on the checked object and the possibility to perform administrative tasks on it. Useful on document and category level.

The link can be rendered as an ordinary link element or a button.